Skip to main content
SnapCenter software
简体中文版经机器翻译而成，仅供参考。如与英语版出现任何冲突，应以英语版为准。

如何使用 Swagger API 网页访问 REST API

PDF

REST API 通过 Swagger 网页公开。您可以访问 Swagger 网页来显示SnapCenter Server REST API，以及手动发出 API 调用。您可以使用 REST API 来帮助管理您的SnapCenter服务器或执行数据保护操作。

您应该知道要在其上执行 REST API 的SnapCenter服务器的管理 IP 地址或域名。

您不需要特殊权限来运行 REST API 客户端。任何用户都可以访问 Swagger 网页。通过 REST API 访问的对象上的相应权限取决于生成用于登录 REST API 的令牌的用户。

步骤

  1. 在浏览器中，输入 URL 以访问 Swagger 网页，格式为 https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/swagger/。

    备注 确保 REST API URL 不包含以下字符：+、.、% 和 &。

  2. 在 Swagger Explore 字段中，如果 Swagger API 文档未自动显示，请键入：https://<SnapCenter_IP_address_or_name>:<SnapCenter_port>/Content/swagger/ SnapCenter.yaml

  3. 单击“探索”。

    显示 API 资源类型或类别的列表。

  4. 单击 API 资源类型可显示该资源类型中的 API。

如果在执行SnapCenter REST API 时遇到意外行为，您可以使用日志文件来找出原因并解决问题。您可以通过单击“监控”>“日志”>“下载”从SnapCenter用户界面下载日志文件。